<!-- HTML header for doxygen 1.8.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>ROSS: core/ross-gvt.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <a href="https://github.com/ROSS-org/ROSS">
   <div id="projectname">ROSS
   </div>
   </a>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_af18cf245e3394ab3b436135935cfd6e.html">core</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">ross-gvt.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="ross-gvt_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef INC_ross_gvt_h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define INC_ross_gvt_h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Initialize the GVT library and parse options.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">/* setup the GVT library (config cmd line args, etc) */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="structtw__optdef.html">tw_optdef</a> *<a class="code" href="ross-gvt_8h.html#a5f11084158c441f3119d608cb25027de">tw_gvt_setup</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">/* start the GVT library (init vars, etc) */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="ross-gvt_8h.html#a0609349515ccf596bffb1efb59ecd2ea">tw_gvt_start</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">/* </span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * GVT computation is broken into two stages:</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * stage 1: determine if GVT computation should be started</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * stage 2: compute GVT</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="ross-gvt_8h.html#ad42b0dfadde0ee424df3c500d8474b9d">tw_gvt_step1</a>(<a class="code" href="structtw__pe.html">tw_pe</a> *);</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="ross-gvt_8h.html#adaa4a98a7109ea6966f83c9b0afc31fd">tw_gvt_step1_realtime</a>(<a class="code" href="structtw__pe.html">tw_pe</a> *);</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="ross-gvt_8h.html#a0d905b32b2567dd637c4926872622a70">tw_gvt_step2</a>(<a class="code" href="structtw__pe.html">tw_pe</a> *);</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * Provide a mechanism to force a GVT computation outside of the </span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * GVT interval (optional)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="ross-gvt_8h.html#a483098cf3c7db0378e825db007a3a300">tw_gvt_force_update</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="ross-gvt_8h.html#a805cc76b3ba7583d9bb9186afc73e2ba">tw_gvt_force_update_realtime</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">/* Set the PE GVT value */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="ross-gvt_8h.html#ac15a895db8d3725b7c6f4d938177597c">tw_gvt_set</a>(<a class="code" href="structtw__pe.html">tw_pe</a> * <a class="code" href="avl__tree_8c.html#ac4c639748d4d5a271d6c54a18f614605">pe</a>, <a class="code" href="ross_8h.html#a80b370bc538e17441aef6afaff852678">tw_stime</a> LVT);</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">/* Returns true if GVT in progress, false otherwise */</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span>  <a class="code" href="ross-gvt_8h.html#a7a58c92b0e80a7be5f3a741f75df71f8">tw_gvt_inprogress</a>(<a class="code" href="structtw__pe.html">tw_pe</a> * <a class="code" href="avl__tree_8c.html#ac4c639748d4d5a271d6c54a18f614605">pe</a>);</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">/* Statistics collection and printing function */</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="ross-gvt_8h.html#a9e95ad0fee8ab038f3196e585c1f694c">tw_gvt_stats</a>(FILE * F);</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="ross-gvt_8h_html_a9e95ad0fee8ab038f3196e585c1f694c"><div class="ttname"><a href="ross-gvt_8h.html#a9e95ad0fee8ab038f3196e585c1f694c">tw_gvt_stats</a></div><div class="ttdeci">void tw_gvt_stats(FILE *F)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00053">mpi_allreduce.c:53</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_ac15a895db8d3725b7c6f4d938177597c"><div class="ttname"><a href="ross-gvt_8h.html#ac15a895db8d3725b7c6f4d938177597c">tw_gvt_set</a></div><div class="ttdeci">int tw_gvt_set(tw_pe *pe, tw_stime LVT)</div></div>
<div class="ttc" id="ross_8h_html_a80b370bc538e17441aef6afaff852678"><div class="ttname"><a href="ross_8h.html#a80b370bc538e17441aef6afaff852678">tw_stime</a></div><div class="ttdeci">double tw_stime</div><div class="ttdef"><b>Definition:</b> <a href="ross_8h_source.html#l00150">ross.h:150</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_ad42b0dfadde0ee424df3c500d8474b9d"><div class="ttname"><a href="ross-gvt_8h.html#ad42b0dfadde0ee424df3c500d8474b9d">tw_gvt_step1</a></div><div class="ttdeci">void tw_gvt_step1(tw_pe *)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00069">mpi_allreduce.c:69</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_a7a58c92b0e80a7be5f3a741f75df71f8"><div class="ttname"><a href="ross-gvt_8h.html#a7a58c92b0e80a7be5f3a741f75df71f8">tw_gvt_inprogress</a></div><div class="ttdeci">static int tw_gvt_inprogress(tw_pe *pe)</div></div>
<div class="ttc" id="structtw__pe_html"><div class="ttname"><a href="structtw__pe.html">tw_pe</a></div><div class="ttdoc">Holds the entire PE state. </div><div class="ttdef"><b>Definition:</b> <a href="ross-types_8h_source.html#l00375">ross-types.h:375</a></div></div>
<div class="ttc" id="structtw__optdef_html"><div class="ttname"><a href="structtw__optdef.html">tw_optdef</a></div><div class="ttdef"><b>Definition:</b> <a href="tw-opts_8h_source.html#l00019">tw-opts.h:19</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_a0609349515ccf596bffb1efb59ecd2ea"><div class="ttname"><a href="ross-gvt_8h.html#a0609349515ccf596bffb1efb59ecd2ea">tw_gvt_start</a></div><div class="ttdeci">void tw_gvt_start(void)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00034">mpi_allreduce.c:34</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_a5f11084158c441f3119d608cb25027de"><div class="ttname"><a href="ross-gvt_8h.html#a5f11084158c441f3119d608cb25027de">tw_gvt_setup</a></div><div class="ttdeci">const tw_optdef * tw_gvt_setup(void)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00026">mpi_allreduce.c:26</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_a0d905b32b2567dd637c4926872622a70"><div class="ttname"><a href="ross-gvt_8h.html#a0d905b32b2567dd637c4926872622a70">tw_gvt_step2</a></div><div class="ttdeci">void tw_gvt_step2(tw_pe *)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00102">mpi_allreduce.c:102</a></div></div>
<div class="ttc" id="avl__tree_8c_html_ac4c639748d4d5a271d6c54a18f614605"><div class="ttname"><a href="avl__tree_8c.html#ac4c639748d4d5a271d6c54a18f614605">pe</a></div><div class="ttdeci">tw_pe * pe</div><div class="ttdef"><b>Definition:</b> <a href="avl__tree_8c_source.html#l00011">avl_tree.c:11</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_adaa4a98a7109ea6966f83c9b0afc31fd"><div class="ttname"><a href="ross-gvt_8h.html#adaa4a98a7109ea6966f83c9b0afc31fd">tw_gvt_step1_realtime</a></div><div class="ttdeci">void tw_gvt_step1_realtime(tw_pe *)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00079">mpi_allreduce.c:79</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_a483098cf3c7db0378e825db007a3a300"><div class="ttname"><a href="ross-gvt_8h.html#a483098cf3c7db0378e825db007a3a300">tw_gvt_force_update</a></div><div class="ttdeci">void tw_gvt_force_update(void)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00039">mpi_allreduce.c:39</a></div></div>
<div class="ttc" id="ross-gvt_8h_html_a805cc76b3ba7583d9bb9186afc73e2ba"><div class="ttname"><a href="ross-gvt_8h.html#a805cc76b3ba7583d9bb9186afc73e2ba">tw_gvt_force_update_realtime</a></div><div class="ttdeci">void tw_gvt_force_update_realtime(void)</div><div class="ttdef"><b>Definition:</b> <a href="mpi__allreduce_8c_source.html#l00046">mpi_allreduce.c:46</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
